Esx Settings AlternativeImageInfo

Esx Settings AlternativeImageInfo
Esx Settings AlternativeImageInfo

The Esx Settings AlternativeImageInfo schema contains properties that describes an alternative image for the desired software specification.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "base_image": {
        "details": {
            "display_name": "string",
            "display_version": "string",
            "release_date": "string",
            "quick_patch_compatible_versions": {
                "quick_patch_compatible_versions": "string"
            }
        },
        "version": "string"
    },
    "add_on": {
        "details": {
            "display_name": "string",
            "vendor": "string",
            "display_version": "string"
        },
        "name": "string",
        "version": "string"
    },
    "components": {
        "components": {
            "version": "string",
            "details": {
                "display_name": "string",
                "vendor": "string",
                "display_version": "string"
            }
        }
    },
    "solutions": {
        "solutions": {
            "details": {
                "display_name": "string",
                "display_version": "string",
                "components": [
                    {
                        "component": "string",
                        "display_name": "string",
                        "display_version": "string",
                        "vendor": "string"
                    }
                ]
            },
            "version": "string",
            "components": [
                {
                    "component": "string"
                }
            ]
        }
    },
    "hardware_support": {
        "packages": {
            "packages": {
                "pkg": "string",
                "version": "string"
            }
        }
    },
    "removed_components": {
        "removed_components": {
            "version": "string",
            "details": {
                "display_name": "string",
                "vendor": "string",
                "display_version": "string"
            }
        }
    },
    "display_name": "string",
    "selection_criteria": {
        "selection_type": "string",
        "host_uuids": [
            "string"
        ],
        "host_hardware_spec": {
            "vendor": "string",
            "models": [
                "string"
            ],
            "families": [
                "string"
            ],
            "oem_strings": [
                "string"
            ]
        }
    }
}
base_image
Required

Base image of the ESX.

This property was added in vSphere API 9.0.0.0.

add_on
Optional

OEM customization on top of given base image. The components in this customization override the components in the base base image.

This property was added in vSphere API 9.0.0.0.

If missing or null, no OEM customization will be applied.

object
components
Required

Information about the components in the software specification.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.

object
solutions
Required

Information about the solutions in the software specification.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.solution.

hardware_support
Optional

Information about the Hardware Support Packages (HSP) configured.

This property was added in vSphere API 9.0.0.0.

If missing or null, no Hardware Support Package (HSP) is specified for the cluster.

object
removed_components
Optional

Information about the components to be removed in the software specification.

This property was added in vSphere API 9.0.0.0.

If missing or null, no removed component is specified for the cluster.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.

string
display_name
Required

Display name of the Alternative Image. Supported encoding is UTF-8.

This property was added in vSphere API 9.0.0.0.

selection_criteria
Required

Selection criteria used to select the alternative image for 1 or more hosts

This property was added in vSphere API 9.0.0.0.